﻿#region Copyright(c) 2006 ZO, All right reserved.
// -----------------------------------------------------------------------------
// Copyright(c) 2006 ZO, All right reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   1.  Redistribution of source code must retain the above copyright notice,
//       this list of conditions and the following disclaimer.
//   2.  Redistribution in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//   3.  The name of the author may not be used to endorse or promote products
//       derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR IMPLIED
// WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
// MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
// EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
// PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
// OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
// OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
// ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// -----------------------------------------------------------------------------
#endregion


#region Using directives

using System;
using ArgumentNullException= ZO.SmartCore.Core.ArgumentNullException;

#endregion

namespace ZO.SmartCore.Configuration
{
    /// <summary>
    /// Represent a Item Key in a Section in configuration file.
    /// </summary>
    public sealed class SectionKey
    {

        #region Constructors
        /// <summary>
        /// Initializes a new instance of the <see cref="SectionKey"/> class.
        /// </summary>
        /// <param name="name">The name.</param>
        public SectionKey(string name)
        {
            if (String.IsNullOrEmpty(name))
            {
                throw new ArgumentNullException("name");
            }
            this._Name = name;
        } // Section


        /// <summary>
        /// Initializes a new instance of the <see cref="SectionKey"/> class.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="value">The value.</param>
        public SectionKey(string name, string value)
            : this(name)
        {
            this._Value = value;

        } // Section

        /// <summary>
        /// Initializes a new instance of the <see cref="SectionKey"/> class.
        /// </summary>
        /// <param name="name">The name.</param>
        /// <param name="value">The value.</param>
        /// <param name="comment">The comment.</param>
        public SectionKey(string name, string value, string comment)
            : this(name)
        {
            this._Comment = comment;
            this._Value = value;
        } // Section
        #endregion

        #region Destructor

        #endregion

        #region Fields
        private string _Name;
        private string _Comment;

        private string _Value;

        #endregion

        #region Events

        #endregion

        #region Operators

        #endregion

        #region Properties
        /// <summary>
        /// Gets the key name.
        /// </summary>
        /// <value>The name.</value>
        public string Name
        {
            get { return _Name; }
        }


        /// <summary>
        /// Gets or sets the section comment.
        /// </summary>
        /// <value>The comment.</value>
        public string Comment
        {
            get
            {
                return _Comment;
            }
            set
            {
                _Comment = value;
            }
        }
        #endregion

        #region Methods
        /// <summary>
        /// Gets or sets the key value.
        /// </summary>
        /// <value>The value.</value>
        public string Value
        {
            get { return _Value; }
            set { _Value = value; }
        }
        #endregion
    }
}
